@favware/querystring

@favware/querystring

Querystring that is robust in its working yet remains awesome to TypeScript users

---

Project Status

Bundle Sizes

Social Media and Donations

---

NodeJS' Querystring, but then with far stronger safety net.

Key Features

• Useable in the browser through jsDelivr, unpkg and bundle.run
• Useable in NodeJS through package manager of choice
• Typesafe
• Bundled with Rollup for maximum size reduction (only 1kB minified + gzipped!), ES module support and browser support
• Generated TypeScript declarations
• Treeshakeable in Webpack

Install

Install with yarn or npm:

yarn add @favware/querystring

# npm install @favware/querystring

---

Usage

Stringify

Create a querystring from a JS object

const { stringify } = require('@favware/querystring');
// import { stringify } from '@favware/querystring';
// with ES modules you can also use a default import for stringify!

console.log(stringify({ prop: 'value', prop2: 'value2' }));
//=> '?prop=value&prop2=value2'

// supply options
console.log(stringify({ prop: 'value', prop2: 'value2' }, { separator: '&', equals: '=', includeQuestion: true }));
//=> '?prop=value&prop2=value2'

// customize options
console.log(stringify({ prop: 'value', prop2: 'value2' }, { separator: '&&', equals: '=', includeQuestion: false }));
//=> 'prop=value&&prop2=value2'

Parse

Create a JS object from a querystring

const { parse } = require('@favware/querystring');
// import { parse } from '@favware/querystring';

console.log(parse('?prop=value&prop2=value2'));
//=> {prop: 'value', prop2: 'value2'}

// supply options
console.log(parse('?prop=value&prop2=value2', { separator: '&', equals: '=' }));
//=> {prop: 'value', prop2: 'value2'}

// customize options
console.log(parse('prop=value&&prop2=value2', { separator: '&&', equals: '=' }));
//=> {prop: 'value', prop2: 'value2'}

API Documentation